Skip to content

Conversation

pierwill
Copy link
Member

Various changes to the rustc_span docs, including the following:

  • Additions to top-level docs
  • Edits to the source_map module docs
  • Edits to documentation for Span and SpanData
  • Added intra-docs links
  • Documentation for Levenshtein distances
  • Fixed missing punctuation

@rust-highfive
Copy link
Contributor

r? @lcnr

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 24, 2020
@jyn514 jyn514 added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Dec 24, 2020
@pierwill pierwill requested review from jyn514 and lcnr December 25, 2020 22:00
@lcnr
Copy link
Contributor

lcnr commented Dec 25, 2020

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 25, 2020

📌 Commit a8791255b1a212722c4e80f6ad5b2a95547b0890 has been approved by lcnr

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 25, 2020
Various changes to the `rustc_span` docs, including the following:

- Additions to top-level docs
- Edits to the source_map module docs
- Edits to documentation for `Span` and `SpanData`
- Added intra-docs links
- Documentation for Levenshtein distances
- Fixed missing punctuation
@@ -124,7 +133,7 @@ pub enum RealFileName {

impl RealFileName {
/// Returns the path suitable for reading from the file system on the local host.
/// Avoid embedding this in build artifacts; see `stable_name` for that.
/// Avoid embedding this in build artifacts; see `stable_name()` for that.
Copy link
Contributor

@theotherphil theotherphil Dec 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a fixed convention for this? The old comment was referring to a function by name, which seems more correct. If there isn’t a well understood convention I could imagine someone else coming along and making the opposite changes as part of a similar comment tidying exercise.

Copy link
Contributor

@lcnr lcnr Dec 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think that we have a fixed convention for this

If there isn’t a well understood convention I could imagine someone else coming along and making the opposite changes as part of a similar comment tidying exercise.

yeah 🤷 i mostly just don't mind either way so asking people to remove/add changes like this seems slightly too pedantic to me.

@lcnr
Copy link
Contributor

lcnr commented Dec 29, 2020

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Dec 29, 2020

📌 Commit a8775d4 has been approved by lcnr

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Dec 29, 2020
Edit rustc_span documentation

Various changes to the `rustc_span` docs, including the following:

- Additions to top-level docs
- Edits to the source_map module docs
- Edits to documentation for `Span` and `SpanData`
- Added intra-docs links
- Documentation for Levenshtein distances
- Fixed missing punctuation
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Dec 30, 2020
Edit rustc_span documentation

Various changes to the `rustc_span` docs, including the following:

- Additions to top-level docs
- Edits to the source_map module docs
- Edits to documentation for `Span` and `SpanData`
- Added intra-docs links
- Documentation for Levenshtein distances
- Fixed missing punctuation
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 30, 2020
Rollup of 13 pull requests

Successful merges:

 - rust-lang#79812 (Lint on redundant trailing semicolon after item)
 - rust-lang#80348 (remove redundant clones (clippy::redundant_clone))
 - rust-lang#80358 (Edit rustc_span documentation)
 - rust-lang#80457 (Add missing commas to `rustc_ast_pretty::pp` docs)
 - rust-lang#80461 (Add llvm-libunwind change to bootstrap CHANGELOG)
 - rust-lang#80464 (Use Option::map_or instead of open coding it)
 - rust-lang#80465 (Fix typo in ffi-pure.md)
 - rust-lang#80467 (More uses of the matches! macro)
 - rust-lang#80469 (Fix small typo in time comment)
 - rust-lang#80472 (Use sans-serif font for the "all items" page links)
 - rust-lang#80477 (Make forget intrinsic safe)
 - rust-lang#80482 (don't clone copy types)
 - rust-lang#80487 (don't redundantly repeat field names)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6064be7 into rust-lang:master Dec 30, 2020
@rustbot rustbot added this to the 1.51.0 milestone Dec 30, 2020
@pierwill pierwill deleted the edit_rustc_span branch February 16, 2021 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants